Genesys Cloud - Developer Community!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Announcement for Platform API SDK for Java, Go and .Net - Modification in some SDK Endpoint method signatures (new parameter introduced)

  • 1.  Announcement for Platform API SDK for Java, Go and .Net - Modification in some SDK Endpoint method signatures (new parameter introduced)

    Posted 3 hours ago

    Hello,

    This post is for information on new versions of the Platform API SDK for Java, Go and .Net.

    A new query parameter was introduced in a set of existing Platform API Endpoints.
    Endpoint Modifications (new query parameter):
    • OperationId: "getUser", URL: "GET /api/v2/users/{userId}", New query parameter: "userCustomAttributeSchemaIds"
    • OperationId: "getUsers", URL: "GET /api/v2/users", New query parameter: "userCustomAttributeSchemaIds"
    • OperationId: "getUsersMe", URL: "GET /api/v2/users/me", New query parameter: "userCustomAttributeSchemaIds"
    • OperationId: "getUsersQuery", URL: "GET /api/v2/users/query", New query parameter: "userCustomAttributeSchemaIds"
     
    This impacts and changes the corresponding SDK method signatures in new versions of the Platform API SDK.
    If you have existing code leveraging these endpoints, when you'll update your Platform API SDK dependency to a version equal or greater than the one listed below, you will need to take this new parameter into account in your function/method call.
     
    The change is effective in the following SDK versions:
    • Platform API SDK for Java - version 251.0.0
    • Platform API SDK for Go - version v185.0.0
    • Platform API SDK for .Net - version 261.0.0
     
    ## Platform API SDK for Java:
    • getUser(String userId, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state)
    • getUserWithHttpInfo(String userId, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state)
    • getUsers(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state)
    • getUsersWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state)
    • getUsersMe(List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds)
    • getUsersMeWithHttpInfo(List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds)
    • getUsersQuery(String cursor, Integer pageSize, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state)
    • getUsersQueryWithHttpInfo(String cursor, Integer pageSize, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state)
     
    ## Platform API SDK for Go:
    • GetUser(userId string, expand []string, integrationPresenceSource string, userCustomAttributeSchemaIds []string, state string)
    • GetUsers(pageSize int, pageNumber int, id []string, jabberId []string, sortOrder string, expand []string, integrationPresenceSource string, userCustomAttributeSchemaIds []string, state string)
    • GetUsersMe(expand []string, integrationPresenceSource string, userCustomAttributeSchemaIds []string)
    • GetUsersQuery(cursor string, pageSize int, sortOrder string, expand []string, integrationPresenceSource string, userCustomAttributeSchemaIds []string, state string)
     
    ## Platform API SDK for .Net:
    • GetUser(string userId, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUserWithHttpInfo(string userId, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUserAsync(string userId, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUserAsyncWithHttpInfo(string userId, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUsers(int? pageSize = null, int? pageNumber = null, List<string> id = null, List<string> jabberId = null, string sortOrder = null, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUsersWithHttpInfo(int? pageSize = null, int? pageNumber = null, List<string> id = null, List<string> jabberId = null, string sortOrder = null, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUsersAsync(int? pageSize = null, int? pageNumber = null, List<string> id = null, List<string> jabberId = null, string sortOrder = null, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUsersAsyncWithHttpInfo(int? pageSize = null, int? pageNumber = null, List<string> id = null, List<string> jabberId = null, string sortOrder = null, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUsersMe(List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null)
    • GetUsersMeWithHttpInfo(List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null)
    • GetUsersMeAsync(List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null)
    • GetUsersMeAsyncWithHttpInfo(List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null)
    • GetUsersQuery(string cursor = null, int? pageSize = null, string sortOrder = null, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUsersQueryWithHttpInfo(string cursor = null, int? pageSize = null, string sortOrder = null, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUsersQueryAsync(string cursor = null, int? pageSize = null, string sortOrder = null, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)
    • GetUsersQueryAsyncWithHttpInfo(string cursor = null, int? pageSize = null, string sortOrder = null, List<string> expand = null, string integrationPresenceSource = null, List<string> userCustomAttributeSchemaIds = null, string state = null)

    Regards,


    #PlatformSDK

    ------------------------------
    Jerome Saint-Marc
    Senior Development Support Engineer
    ------------------------------


Related Content