phschroeder | 2023-03-20 20:05:00 UTC | #1
Hello,
I am looking for documentation for the APIs, data schema/dictionary.
I would like to know all possible name(key) / value pairs for Each API in the resulting JSON • Define the possible data types for the key/value: o Null o String o Number o True/false o Object o Array • For the key/value pairs that have a fixed list of values, define all possible values • Definition of fixed values i.e. o “howEnded”: “Disconnect” o “disconnectType”: “peer” o “type”: “System” o “purpose”: “ivr” o Etc.
I hope I am using the correct terminology, I am not a developer, but I want to communicate with my developers effectively & efficiently!
tim.smith | 2023-03-20 20:14:59 UTC | #2
Hello, Genesys Cloud does not have a data dictionary as it is not an RDBMS-based system. You can find the API documentation here: https://developer.genesys.cloud/devapps/api-explorer. If you're trying to extract data from the API to store in a RDBMS, I would suggest looking over this blueprint: https://developer.genesys.cloud/blueprints/conversation-model-to-sql-blueprint/.
phschroeder | 2023-03-22 00:23:09 UTC | #3
Hi Tim, Thank You for your quick response! Again forgive me if I do not have the terminology right. I think I am close to what I am looking for. Looking at the following: https://developer.genesys.cloud/analyticsdatamanagement/analytics/dimensions
Could I impose on you to explain what "Dimensions" is vs key(name) in JSON? The reason I say close is looking at some of the key/value pairs, I can not find several in this "Dimensions" documentation. A few examples are: participantType mediaRoles state initialState type addressDisplayable
Also some enum values could use some definition, one example is: disconnectType - Enum - noAnswerTransfer, notAvailableTransfer, other, peer Is that documented someplace? Everything I referenced is JSON from GET /api/v2/conversations/{conversationId}
Your guidance is much appreciated! TYIA
tim.smith | 2023-03-22 16:42:05 UTC | #4
Dimensions are documented here: https://developer.genesys.cloud/analyticsdatamanagement/analytics/dimensions
system | 2023-04-22 16:42:25 UTC | #5
This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.
This post was migrated from the old Developer Forum.
ref: 19005