Emergency breaking change to usage query

Description

A change to POST /api/v2/oauth/clients/{clientId}/usage/query was introduced for additional validation within the Genesys Cloud Platform API and added business logic within the query service that checks if all post body parameters are valid.

Change Category

API, emergency change

Change Context

It was identified that an aspect of the query could be misused providing more detail than expected in the query.

Change Impact

For the request to POST /api/v2/oauth/clients/{clientId}/usage/query, userId has been removed as a valid value for the groupBy parameter. Requests including the value userId for groupBy will now be serviced with a 400 error response.

Additionally, the response for GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId} will no longer include the userId property with a GUID value.

Date of Change

Jun 6, 2023

Impacted APIs

  • POST /api/v2/oauth/clients/{clientId}/usage/query
  • GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}

References

USAGE-1152

This topic was automatically closed 62 days after the last reply. New replies are no longer allowed.