Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Platform API SDK for JavaScript – Fix for Incorrect Query Parameter Processing (boolean, integer, number)

  • 1.  Platform API SDK for JavaScript – Fix for Incorrect Query Parameter Processing (boolean, integer, number)

    Posted 09-08-2025 09:43
    Edited by Ananya Singh 09-08-2025 11:17

    Summary

    The Platform API SDK for JavaScript currently ignores (filters out) query parameters of type boolean when the value is false, and query parameters of type integer/number when the value is 0.

    API endpoints with a boolean query parameter whose default value is not false (or has no default specified) are impacted.

    Examples

    • Impacted: getDownload – issueRedirect default value is true
    • Not impacted: getOutboundDnclistExport – download default value is false

    This behavior will be corrected in future versions of the Platform API SDK for JavaScript.

    Given that this issue has existed for a long time and could affect applications that rely on such parameters (set to false or 0), the following approach is being taken:

    • The SDK will initially continue the legacy filtering behavior (ignoring boolean false and integer/number 0 values).
    • A new property is introduced at the ApiClient level to control this behavior.
      • When UseLegacyParameterFilter is true (default), the SDK applies the legacy filter.
      • This default facilitates a safe transition to modern, accurate filtering without risking unintended behavior changes in existing applications.

    To enable accurate filtering, set UseLegacyParameterFilter to false:

    const client = {{moduleName}}.ApiClient.instance; 
// Use modern and accurate parameter filtering 
client.setUseLegacyParameterFilter(false);

    This change applies to new versions of the Platform API SDK for JavaScript released on and after Tuesday, September 30, 2025.

    Effective Date

    Tuesday, September 30, 2025

    Details

    Fixing incorrect processing on API endpoints with query parameters of type boolean, integer, or number.

    Customer Impact

    • No impact for applications that retain legacy filtering (UseLegacyParameterFilter = true, default).
    • If switching to modern filtering (UseLegacyParameterFilter = false):
      • Boolean parameters with default false:
        • Not impacted if these parameters are not used.
        • If used and set to false, behavior should remain consistent (matches default).
      • Boolean parameters with default true or with no default:
        • Not impacted if these parameters are not used.
        • If used and set to false, behavior can change (since false is not the default).

    A pre-release of the Platform API SDK for JavaScript reflecting this change is available in the prerelease-08-2025 branch of the platform-client-sdk-javascriptrepository: https://github.com/MyPureCloud/platform-client-sdk-javascript/tree/prerelease-08-2025.

    If any differences are detected during pre-release testing, please contact the designated support channels listed below.

    Impacted Resources

    The following Platform API endpoints include at least one query parameter of type boolean, integer, or number and may be affected.

    Possible impact – Platform API endpoints with impacted parameters:

    • getTokensMe: GET /api/v2/tokens/me

    • No default specified: preserveIdleTTL (boolean)

    • getAnalyticsReportingDashboardsUsers: GET /api/v2/analytics/reporting/dashboards/users

    • No default specified: deletedOnly (boolean)

    • getAnalyticsReportingSettingsUserDashboards: GET /api/v2/analytics/reporting/settings/users/{userId}/dashboards

    • No default specified: publicOnly (boolean), favoriteOnly (boolean), deletedOnly (boolean)

    • getAuditsQueryTransactionIdResults: GET /api/v2/audits/query/{transactionId}/results

    • No default specified: allowRedirect (boolean)

    • getAuthorizationRole: GET /api/v2/authorization/roles/{roleId}

    • Default differs: userCount (boolean – default: true)

    • getAuthorizationRoles: GET /api/v2/authorization/roles

    • Default differs: userCount (boolean – default: true)

    • getChatsRoomMessages: GET /api/v2/chats/rooms/{roomJid}/messages

    • No default specified: excludeMetadata (boolean)

    • getChatsUserMessages: GET /api/v2/chats/users/{userId}/messages

    • No default specified: excludeMetadata (boolean)

    • getChatsRoomParticipants: GET /api/v2/chats/rooms/{roomJid}/participants

    • No default specified: notify (boolean)

    • getChatsThreadMessages: GET /api/v2/chats/threads/{threadId}/messages

    • No default specified: excludeMetadata (boolean)

    • getRecordingCrossplatformMediaretentionpolicies: GET /api/v2/recording/crossplatform/mediaretentionpolicies

    • Matches default: summary (boolean)

    • No default specified: enabled (boolean), hasErrors (boolean), deleteDaysThreshold (integer)

    • getRecordingMediaretentionpolicies: GET /api/v2/recording/mediaretentionpolicies

    • Matches default: summary (boolean)

    • No default specified: enabled (boolean), hasErrors (boolean), deleteDaysThreshold (integer)

    • postExternalcontactsBulkContactsEnrich: POST /api/v2/externalcontacts/bulk/contacts/enrich

    • No default specified: dryRun (boolean)

    • postExternalcontactsBulkOrganizationsEnrich: POST /api/v2/externalcontacts/bulk/organizations/enrich

    • No default specified: dryRun (boolean)

    • getExternalcontactsScanContactsDivisionviewsAll: GET /api/v2/externalcontacts/scan/contacts/divisionviews/all

    • No default specified: limit (integer)

    • getExternalcontactsScanContacts: GET /api/v2/externalcontacts/scan/contacts

    • No default specified: limit (integer)

    • postExternalcontactsContactsEnrich: POST /api/v2/externalcontacts/contacts/enrich

    • No default specified: dryRun (boolean)

    • postExternalcontactsOrganizationsEnrich: POST /api/v2/externalcontacts/organizations/enrich

    • No default specified: dryRun (boolean)

    • getExternalcontactsOrganization: GET /api/v2/externalcontacts/organizations/{externalOrganizationId}

    • No default specified: includeTrustors (boolean)

    • getExternalcontactsOrganizations: GET /api/v2/externalcontacts/organizations

    • No default specified: includeTrustors (boolean)

    • getExternalcontactsScanOrganizationsDivisionviewsAll: GET /api/v2/externalcontacts/scan/organizations/divisionviews/all

    • No default specified: limit (integer)

    • getExternalcontactsScanOrganizations: GET /api/v2/externalcontacts/scan/organizations

    • No default specified: limit (integer)

    • getExternalcontactsExternalsources: GET /api/v2/externalcontacts/externalsources

    • No default specified: limit (integer), active (boolean)

    • getExternalcontactsContactJourneySegments: GET /api/v2/externalcontacts/contacts/{contactId}/journey/segments

    • No default specified: includeMerged (boolean), limit (integer)

    • getExternalcontactsContactJourneySessions: GET /api/v2/externalcontacts/contacts/{contactId}/journey/sessions

    • No default specified: includeMerged (boolean)

    • getExternalcontactsScanNotesDivisionviewsAll: GET /api/v2/externalcontacts/scan/notes/divisionviews/all

    • No default specified: limit (integer)

    • getExternalcontactsScanNotes: GET /api/v2/externalcontacts/scan/notes

    • No default specified: limit (integer)

    • getExternalcontactsScanRelationshipsDivisionviewsAll: GET /api/v2/externalcontacts/scan/relationships/divisionviews/all

    • No default specified: limit (integer)

    • getExternalcontactsScanRelationships: GET /api/v2/externalcontacts/scan/relationships

    • No default specified: limit (integer)

    • postContentmanagementDocumentContent: POST /api/v2/contentmanagement/documents/{documentId}/content

    • No default specified: override (boolean)

    • postContentmanagementDocument: POST /api/v2/contentmanagement/documents/{documentId}

    • No default specified: override (boolean)

    • deleteContentmanagementDocument: DELETE /api/v2/contentmanagement/documents/{documentId}

    • No default specified: override (boolean)

    • postContentmanagementDocuments: POST /api/v2/contentmanagement/documents

    • No default specified: override (boolean)

    • getConversationsChatMessages: GET /api/v2/conversations/chats/{conversationId}/messages

    • Default differs: maxResults (integer – default: 100)

    • patchConversationsEmailMessagesDraft: PATCH /api/v2/conversations/emails/{conversationId}/messages/draft

    • No default specified: autoFill (boolean), discard (boolean)

    • getFlowsDatatableRow: GET /api/v2/flows/datatables/{datatableId}/rows/{rowId}

    • Default differs: showbrief (boolean – default: true)

    • getFlowsDatatableRows: GET /api/v2/flows/datatables/{datatableId}/rows

    • Default differs: showbrief (boolean – default: true)

    • getOutboundCampaignLinedistribution: GET /api/v2/outbound/campaigns/{campaignId}/linedistribution

    • No default specified: useWeight (boolean), relativeWeight (integer), outboundLineCount (integer)

    • Default differs: includeOnlyActiveCampaigns (boolean – default: true)

    • putOutboundCampaign: PUT /api/v2/outbound/campaigns/{campaignId}

    • No default specified: useMaxCallsPerAgentDecimal (boolean)

    • postOutboundCampaigns: POST /api/v2/outbound/campaigns

    • No default specified: useMaxCallsPerAgentDecimal (boolean)

    • postOutboundContactlistContacts: POST /api/v2/outbound/contactlists/{contactListId}/contacts

    • No default specified: priority (boolean), clearSystemData (boolean), doNotQueue (boolean)

    • patchOutboundSettings: PATCH /api/v2/outbound/settings

    • No default specified: useMaxCallsPerAgentDecimal (boolean)

    • getDownload: GET /api/v2/downloads/{downloadId}

    • Default differs: issueRedirect (boolean – default: true), redirectToAuth (boolean – default: true)

    • postFlowsInstancesQuery: POST /api/v2/flows/instances/query

    • No default specified: indexOnly (boolean)

    • postGamificationProfiles: POST /api/v2/gamification/profiles

    • Default differs: copyMetrics (boolean – default: true)

    • getGamificationInsightsRankings: GET /api/v2/gamification/insights/rankings

    • No default specified: sectionSize (integer)

    • postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs: POST /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs

    • Default differs: onlyRegisteredBots (boolean – default: true)

    • getIntegrationsSpeechNuanceNuanceIntegrationIdBots: GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots

    • Default differs: onlyRegisteredBots (boolean – default: true)

    • deleteJourneyActiontemplate: DELETE /api/v2/journey/actiontemplates/{actionTemplateId}

    • No default specified: hardDelete (boolean)

    • getJourneySegments: GET /api/v2/journey/segments

    • No default specified: isActive (boolean)

    • getKnowledgeKnowledgebaseCategories: GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories

    • No default specified: isRoot (boolean), includeDocumentCount (boolean)

    • getKnowledgeKnowledgebases: GET /api/v2/knowledge/knowledgebases

    • No default specified: published (boolean)

    • getKnowledgeKnowledgebaseLabels: GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels

    • No default specified: includeDocumentCount (boolean)

    • getKnowledgeKnowledgebaseDocuments: GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents

    • No default specified: includeSubcategories (boolean), includeDrafts (boolean)

    • getKnowledgeKnowledgebaseDocumentFeedback: GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback

    • No default specified: onlyCommented (boolean)

    • getLanguageunderstandingDomainFeedback: GET /api/v2/languageunderstanding/domains/{domainId}/feedback

    • Matches default: enableCursorPagination (boolean)

    • No default specified: includeDeleted (boolean)

    • Default differs: includeTrainingUtterances (boolean – default: true)

    • getLanguageunderstandingDomainVersion: GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}

    • No default specified: includeUtterances (boolean)

    • getLanguageunderstandingDomainVersions: GET /api/v2/languageunderstanding/domains/{domainId}/versions

    • No default specified: includeUtterances (boolean)

    • postLanguageunderstandingDomainVersions: POST /api/v2/languageunderstanding/domains/{domainId}/versions

    • No default specified: includeUtterances (boolean)

    • getOrganizationsLimitsChangerequests: GET /api/v2/organizations/limits/changerequests

    • No default specified: after (integer), before (integer)

    • getJourneyDeploymentCustomerPing: GET /api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping

    • No default specified: sinceLastBeaconMilliseconds (integer)

    • getKnowledgeGuestSessionCategories: GET /api/v2/knowledge/guest/sessions/{sessionId}/categories

    • No default specified: isRoot (boolean), includeDocumentCount (boolean)

    • getNotificationsAvailabletopics: GET /api/v2/notifications/availabletopics

    • Default differs: includePreview (boolean – default: true)

    • postOrgauthorizationTrusteesCare: POST /api/v2/orgauthorization/trustees/care

    • No default specified: assignDefaultRole (boolean), autoExpire (boolean), assignFullAccess (boolean), allowTrustedUserAccess (boolean)

    • postOrgauthorizationTrusteesDefault: POST /api/v2/orgauthorization/trustees/default

    • No default specified: assignDefaultRole (boolean), autoExpire (boolean)

    • getProcessautomationTriggers: GET /api/v2/processautomation/triggers

    • No default specified: enabled (boolean), hasDelayBy (boolean)

    • putRecordingsDeletionprotection: PUT /api/v2/recordings/deletionprotection

    • Default differs: protect (boolean – default: true)

    • getQualityEvaluationsQuery: GET /api/v2/quality/evaluations/query

    • Matches default: includeDeletedUsers (boolean)

    • No default specified: isReleased (boolean), agentHasRead (boolean), expandAnswerTotalScores (boolean), maximum (integer)

    • putConversationRecording: PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}

    • No default specified: clearExport (boolean)

    • getConversationRecordings: GET /api/v2/conversations/{conversationId}/recordings

    • Matches default: includePauseAnnotationsForScreenRecordings (boolean)

    • Default differs: maxWaitMs (integer – default: 5000)

    • getRecordingsRetentionQuery: GET /api/v2/recordings/retention/query

    • No default specified: retentionThresholdDays (integer)

    • getRecordingJobFailedrecordings: GET /api/v2/recording/jobs/{jobId}/failedrecordings

    • No default specified: includeTotal (boolean)

    • getRecordingJobs: GET /api/v2/recording/jobs

    • No default specified: showOnlyMyJobs (boolean), includeTotal (boolean)

    • getQualityFormsSurveysBulkContexts: GET /api/v2/quality/forms/surveys/bulk/contexts

    • Default differs: published (boolean – default: true)

    • deleteRoutingQueue: DELETE /api/v2/routing/queues/{queueId}

    • No default specified: forceDelete (boolean)

    • getRoutingQueuesMe: GET /api/v2/routing/queues/me

    • No default specified: joined (boolean)

    • getRoutingQueues: GET /api/v2/routing/queues

    • No default specified: hasPeer (boolean)

    • getRoutingQueueMembers: GET /api/v2/routing/queues/{queueId}/members

    • No default specified: joined (boolean)

    • getRoutingQueueUsers: GET /api/v2/routing/queues/{queueId}/users

    • No default specified: joined (boolean)

    • getScimGroups: GET /api/v2/scim/groups

    • Default differs: startIndex (integer – default: 1), count (integer – default: 25)

    • getScimUsers: GET /api/v2/scim/users

    • Default differs: startIndex (integer – default: 1), count (integer – default: 25)

    • getScimV2Groups: GET /api/v2/scim/v2/groups

    • Default differs: startIndex (integer – default: 1), count (integer – default: 25)

    • getScimV2Users: GET /api/v2/scim/v2/users

    • Default differs: startIndex (integer – default: 1), count (integer – default: 25)

    • getSearch: GET /api/v2/search

    • Default differs: profile (boolean – default: true)

    • postSearch: POST /api/v2/search

    • Default differs: profile (boolean – default: true)

    • getSearchSuggest: GET /api/v2/search/suggest

    • Default differs: profile (boolean – default: true)

    • postSearchSuggest: POST /api/v2/search/suggest

    • Default differs: profile (boolean – default: true)

    • getSocialmediaTopicDataingestionrules: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersions: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesOpenOpenId: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesOpenOpenIdVersion: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesOpenOpenIdVersions: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersion: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleIdVersions: GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions

    • No default specified: includeDeleted (boolean)

    • getSocialmediaTopic: GET /api/v2/socialmedia/topics/{topicId}

    • No default specified: includeDeleted (boolean)

    • deleteSocialmediaTopic: DELETE /api/v2/socialmedia/topics/{topicId}

    • No default specified: hardDelete (boolean)

    • getSocialmediaTopics: GET /api/v2/socialmedia/topics

    • No default specified: includeDeleted (boolean)

    • getTelephonyProvidersEdges: GET /api/v2/telephony/providers/edges

    • No default specified: managed (boolean)

    • Default differs: showCloudMedia (boolean – default: true)

    • getTelephonyProvidersEdgesEdgegroups: GET /api/v2/telephony/providers/edges/edgegroups

    • No default specified: managed (boolean)

    • getTelephonyProvidersEdgesSites: GET /api/v2/telephony/providers/edges/sites

    • No default specified: managed (boolean)

    • getTelephonyProvidersEdgesTrunkbasesetting: GET /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}

    • No default specified: ignoreHidden (boolean)

    • getTelephonyProvidersEdgesTrunkbasesettings: GET /api/v2/telephony/providers/edges/trunkbasesettings

    • No default specified: recordingEnabled (boolean), ignoreHidden (boolean), managed (boolean)

    • getInfrastructureascodeJobs: GET /api/v2/infrastructureascode/jobs

    • Matches default: includeErrors (boolean)

    • Default differs: maxResults (integer – default: 1)

    • getTextbotsBotsSearch: GET /api/v2/textbots/bots/search

    • No default specified: virtualAgentEnabled (boolean)

    • getUserrecordingMedia: GET /api/v2/userrecordings/{recordingId}/media

    • No default specified: async (boolean)

    • getUsersChatsMe: GET /api/v2/users/chats/me

    • No default specified: excludeClosed (boolean), includePresence (boolean)

    • getUserQueues: GET /api/v2/users/{userId}/queues

    • Default differs: joined (boolean – default: true)

    • getArchitectDependencytrackingObject: GET /api/v2/architect/dependencytracking/object

    • No default specified: consumedResources (boolean), consumingResources (boolean), consumedResourceRequest (boolean)

    • getArchitectDependencytracking: GET /api/v2/architect/dependencytracking

    • No default specified: consumedResources (boolean), consumingResources (boolean)

    • getFlowVersions: GET /api/v2/flows/{flowId}/versions

    • No default specified: deleted (boolean)

    • getFlows: GET /api/v2/flows

    • Matches default: deleted (boolean), includeSchemas (boolean)

    • No default specified: virtualAgentEnabled (boolean)

    • getArchitectGrammar: GET /api/v2/architect/grammars/{grammarId}

    • No default specified: includeFileUrls (boolean)

    • getArchitectGrammars: GET /api/v2/architect/grammars

    • No default specified: includeFileUrls (boolean)

    • getArchitectPrompt: GET /api/v2/architect/prompts/{promptId}

    • Default differs: includeMediaUris (boolean – default: true), includeResources (boolean – default: true)

    • deleteArchitectPrompt: DELETE /api/v2/architect/prompts/{promptId}

    • No default specified: allResources (boolean)

    • getArchitectPrompts: GET /api/v2/architect/prompts

    • Default differs: includeMediaUris (boolean – default: true), includeResources (boolean – default: true)

    • getArchitectSystemprompt: GET /api/v2/architect/systemprompts/{promptId}

    • Default differs: includeMediaUris (boolean – default: true), includeResources (boolean – default: true)

    • getArchitectSystemprompts: GET /api/v2/architect/systemprompts

    • Default differs: includeMediaUris (boolean – default: true), includeResources (boolean – default: true)

    • getWebchatGuestConversationMessages: GET /api/v2/webchat/guest/conversations/{conversationId}/messages

    • Default differs: maxResults (integer – default: 100)

    • getWebdeploymentsConfigurations: GET /api/v2/webdeployments/configurations

    • No default specified: showOnlyPublished (boolean)

    • getWorkforcemanagementBusinessunitActivitycodes: GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes

    • No default specified: forceDownloadService (boolean)

    • postWorkforcemanagementBusinessunitIntraday: POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday

    • No default specified: forceAsync (boolean)

    • postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate: POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate

    • No default specified: forceAsync (boolean)

    • getWorkforcemanagementBusinessunitWeekShorttermforecastData: GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data

    • No default specified: weekNumber (integer), forceDownloadService (boolean)

    • getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata: GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata

    • No default specified: forceDownloadService (boolean)

    • postWorkforcemanagementBusinessunitWeekShorttermforecastCopy: POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy

    • No default specified: forceAsync (boolean)

    • getWorkforcemanagementBusinessunit: GET /api/v2/workforcemanagement/businessunits/{businessUnitId}

    • No default specified: includeSchedulingDefaultMessageSeverities (boolean)

    • patchWorkforcemanagementBusinessunit: PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}

    • No default specified: includeSchedulingDefaultMessageSeverities (boolean)

    • postWorkforcemanagementBusinessunits: POST /api/v2/workforcemanagement/businessunits

    • No default specified: includeSchedulingDefaultMessageSeverities (boolean)

    • getWorkforcemanagementManagementunitAgent: GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}

    • No default specified: excludeCapabilities (boolean)

    • postWorkforcemanagementManagementunitAgentsWorkplansQuery: POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query

    • No default specified: forceDownloadService (boolean)

    • getWorkforcemanagementBusinessunitStaffinggroups: GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups

    • No default specified: forceDownloadService (boolean)

    • postWorkforcemanagementBusinessunitStaffinggroupsQuery: POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query

    • No default specified: forceDownloadService (boolean)

    • postWorkforcemanagementManagementunitWeekShifttradesSearch: POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search

    • No default specified: forceDownloadService (boolean)

    • getWorkforcemanagementManagementunitWeekShifttrades: GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades

    • No default specified: forceDownloadService (boolean)

    • Default differs: evaluateMatches (boolean – default: true)

    • postWorkforcemanagementManagementunitWeekShifttradesStateBulk: POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk

    • No default specified: forceAsync (boolean)

    • postWorkforcemanagementAgentAdherenceExplanationsQuery: POST /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query

    • No default specified: forceAsync (boolean), forceDownloadService (boolean)

    • postWorkforcemanagementBusinessunitAdherenceExplanationsQuery: POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query

    • No default specified: forceAsync (boolean), forceDownloadService (boolean)

    • postWorkforcemanagementAdherenceExplanationsQuery: POST /api/v2/workforcemanagement/adherence/explanations/query

    • No default specified: forceAsync (boolean), forceDownloadService (boolean)

    • getWorkforcemanagementManagementunitAdherence: GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence

    • No default specified: forceDownloadService (boolean)

    • postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch: POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search

    • No default specified: forceAsync (boolean)

    • getWorkforcemanagementAlternativeshiftsTrades: GET /api/v2/workforcemanagement/alternativeshifts/trades

    • No default specified: forceAsync (boolean)

    • postWorkforcemanagementBusinessunitAgentschedulesSearch: POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search

    • No default specified: forceAsync (boolean), forceDownloadService (boolean)

    • getWorkforcemanagementBusinessunitWeekSchedules: GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules

    • No default specified: includeOnlyPublished (boolean)

    • getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast: GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast

    • No default specified: forceDownload (boolean)

    • postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery: POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query

    • No default specified: forceAsync (boolean), forceDownloadService (boolean)

    • postWorkforcemanagementManagementunitAgentschedulesSearch: POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search

    • No default specified: forceAsync (boolean), forceDownloadService (boolean)

    • getWorkforcemanagementManagementunitWeekSchedules: GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules

    • No default specified: includeOnlyPublished (boolean)

    • getWorkforcemanagementManagementunitWeekSchedule: GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}

    • No default specified: forceDownloadService (boolean)

    • postWorkforcemanagementManagementunitTimeoffrequestsQuery: POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query

    • No default specified: forceDownloadService (boolean)

    • getWorkforcemanagementBusinessunitTimeoffplans: GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans

    • No default specified: forceDownloadService (boolean)

    • getLearningAssignmentsMe: GET /api/v2/learning/assignments/me

    • No default specified: minPercentageScore (number), maxPercentageScore (number)

    • getLearningAssignments: GET /api/v2/learning/assignments

    • No default specified: minPercentageScore (number), maxPercentageScore (number)

    Issue References

    DEVTOOLING-1244

    Contacts

    @Jerome Saint-Marc  

    Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.



Related Content